Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Hub Generated] Publish private branch 'eatkimchee-fist-Microsoft.IoTFirmwareDefense-2023-02-08-preview' #23921

Conversation

eatkimchee
Copy link
Member

@eatkimchee eatkimchee commented May 11, 2023

This is a PR generated at OpenAPI Hub. You can view your work branch via this link.

ARM API Information (Control Plane)

Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

Changelog

Add a changelog entry for this PR by answering the following questions:

  1. What's the purpose of the update?
    • new service onboarding
    • new API version
    • update existing version for new feature
    • update existing version to fix swagger quality issue in s360
    • Other, please clarify
  2. When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
    May 31, 2023
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
    May 31, 2023
  4. By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

  • Change to data plane APIs
  • Adding new properties
  • All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

  • Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
  • Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.

  • If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.

NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)

Please follow the link to find more details on PR review process.

@eatkimchee
Copy link
Member Author

The PR is created based on the updates in the private branch. The updates in the PR has already been reviewed and approved with this PR Azure/azure-rest-api-specs-pr/12395

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented May 11, 2023

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️LintDiff succeeded [Detail] [Expand]
Validation passes for LintDiff.
compared tags (via openapi-validator v2.1.1) new version base version
package-2023-02-08-preview package-2023-02-08-preview(5075b08) default(main)
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️❌~[Staging] ServiceAPIReadinessTest: 17 Errors, 0 Warnings failed [Detail]

Tag package-2023-02-08-preview; Prod region: Deployed

Test run on region: westeurope; Operation coverage: total: 28, untested: 0, failed: 17, passed: 11

Service API Readiness Test failed. Check pipeline artifact for detail report.

Rule Message
CLIENT_ERROR statusCode: 400,
errorCode: ResourcePostActionFailed,
errorMessage: ResourcePostActionFailed: Bad Request
Source: runtime
OperationId: Workspaces_GenerateUploadUrl
CLIENT_ERROR statusCode: 412,
errorCode: HttpResponsePayloadAPISpecValidationFailed,
errorMessage: Failed to create HTTP response as per the API specification with one or more errors. Please see details for more information. Consider to retry operation with api-versions ''.
Source: runtime
OperationId: Firmware_GenerateComponentDetails
CLIENT_ERROR statusCode: 404,
errorCode: ResourcePostActionFailed,
errorMessage: ResourcePostActionFailed: Resource Not Found
Source: runtime
OperationId: Firmware_GenerateDownloadUrl
CLIENT_ERROR statusCode: 400,
errorCode: ResourcePostActionFailed,
errorMessage: ResourcePostActionFailed: Bad Request
Source: runtime
OperationId: Firmware_ListGeneratePasswordHashList
CLIENT_ERROR statusCode: 400,
errorCode: ResourcePostActionFailed,
errorMessage: ResourcePostActionFailed: Bad Request
Source: runtime
OperationId: Firmware_GenerateCveSummary
CLIENT_ERROR statusCode: 404,
errorCode: ResourcePostActionFailed,
errorMessage: ResourcePostActionFailed: Resource Not Found
Source: runtime
OperationId: Firmware_GenerateFilesystemDownloadUrl
CLIENT_ERROR statusCode: 400,
errorCode: ResourcePostActionFailed,
errorMessage: ResourcePostActionFailed: Bad Request
Source: runtime
OperationId: Firmware_ListGenerateCveList
CLIENT_ERROR statusCode: 400,
errorCode: ResourcePostActionFailed,
errorMessage: ResourcePostActionFailed: Bad Request
Source: runtime
OperationId: Firmware_GenerateCryptoKeySummary
CLIENT_ERROR statusCode: 400,
errorCode: ResourcePostActionFailed,
errorMessage: ResourcePostActionFailed: Bad Request
Source: runtime
OperationId: Firmware_GenerateSummary
CLIENT_ERROR statusCode: 400,
errorCode: ResourcePostActionFailed,
errorMessage: ResourcePostActionFailed: Bad Request
Source: runtime
OperationId: Firmware_GenerateCryptoCertificateSummary
CLIENT_ERROR statusCode: 400,
errorCode: ResourcePostActionFailed,
errorMessage: ResourcePostActionFailed: Bad Request
Source: runtime
OperationId: Firmware_ListGenerateCryptoCertificateList
CLIENT_ERROR statusCode: 400,
errorCode: ResourcePostActionFailed,
errorMessage: ResourcePostActionFailed: Bad Request
Source: runtime
OperationId: Firmware_GenerateBinaryHardeningSummary
CLIENT_ERROR statusCode: 400,
errorCode: ResourcePostActionFailed,
errorMessage: ResourcePostActionFailed: Bad Request
Source: runtime
OperationId: Firmware_ListGenerateComponentList
CLIENT_ERROR statusCode: 400,
errorCode: ResourcePostActionFailed,
errorMessage: ResourcePostActionFailed: Bad Request
Source: runtime
OperationId: Firmware_ListGenerateCryptoKeyList
CLIENT_ERROR statusCode: 400,
errorCode: ResourcePostActionFailed,
errorMessage: ResourcePostActionFailed: Bad Request
Source: runtime
OperationId: Firmware_ListGenerateBinaryHardeningList
CLIENT_ERROR statusCode: 412,
errorCode: HttpResponsePayloadAPISpecValidationFailed,
errorMessage: Failed to create HTTP response as per the API specification with one or more errors. Please see details for more information. Consider to retry operation with api-versions ''.
Source: runtime
OperationId: Firmware_GenerateBinaryHardeningDetails
CLIENT_ERROR statusCode: 404,
errorCode: InvalidResourceType,
errorMessage: The resource type 'operations' could not be found in the namespace 'Microsoft.IoTFirmwareDefense' for api version '2023-02-08-preview'. The supported api-versions are '2021-11-10-privatepreview,2022-09-15-privatepreview'.
Source: runtime
OperationId: Operations_List
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Posted by Swagger Pipeline | How to fix these errors?

@openapi-workflow-bot
Copy link

Hi, @eatkimchee Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

  • Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected]

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 11, 2023

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

    Breaking Changes Tracking

    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 5b07a79. SDK Automation 14.0.0
      command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
      cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
      command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
      cmderr	[automation_generate.sh] npm notice
      cmderr	[automation_generate.sh] npm notice New minor version of npm available! 9.5.1 -> 9.6.6
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.6.6>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
      cmderr	[automation_generate.sh] npm notice
      warn	No file changes detected after generation
      warn	No package detected after generation
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 5b07a79. SDK Automation 14.0.0
      command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
      cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.1.2
      cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
      cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.1.2
      cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
      command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
    • ️✔️azure-resourcemanager-fist [View full logs]  [Release SDK Changes]
    ️⚠️ azure-sdk-for-js warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 5b07a79. SDK Automation 14.0.0
      command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
      warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
      command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
      warn	No file changes detected after generation
      warn	No package detected after generation
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 5b07a79. Schema Automation 14.0.0
      command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
      cmderr	[initScript.sh]  WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
      cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
      cmderr	[initScript.sh] npm WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
      cmderr	[initScript.sh] npm WARN old lockfile
      warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
      command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 11, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Java azure-resourcemanager-fist https://apiview.dev/Assemblies/Review/ed657d9d60114c47b915011f8ce8a3e8

    @openapi-workflow-bot
    Copy link

    Hi @eatkimchee, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic validationFix-SemanticValidation-ErrorHigh
    Model validationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffhigh
    If you need further help, please feedback via swagger feedback.

    @openapi-workflow-bot
    Copy link

    Hi, @eatkimchee, our workflow has detected that there is no management SDK ever released for your RP, to further process SDK onboard for your RP, you should have the SDK client library name of your RP reviewed and approved.
    Action Required:

  • Follow this guidance Naming for new initial management or client libraries (new SDKs) - Overview (azure.com) to create an issue for management client library name arch board review.
  • Paste the issue link that you created in step 1 in this PR

  • Impact: SDK release owner will take the approved management client library name to release SDK. No client library name approval will leads to SDK release delayed.

    @openapi-workflow-bot
    Copy link

    Hi, @eatkimchee your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]).

    - remove references to old private preview versions from readme.md
    - add binary hardening flags to custom-words.txt
    @eatkimchee
    Copy link
    Member Author

    Thanks @ihsanali01 , just added minor changes that should fix the validation errors (no swagger changes, just readme and custom words). No idea why the SwaggerAPIView check failed the second time, seems unrelated

    @AzureRestAPISpecReview AzureRestAPISpecReview added ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test and removed CI-FixRequiredOnFailure labels May 11, 2023
    @eatkimchee
    Copy link
    Member Author

    I triggered the APIView job to run again and it passed, but this PR didn't update showing that it passed
    https://dev.azure.com/azure-sdk/internal/_build/results?buildId=2767030&view=results

    @JackTn
    Copy link
    Member

    JackTn commented May 11, 2023

    I triggered the APIView job to run again and it passed, but this PR didn't update showing that it passed https://dev.azure.com/azure-sdk/internal/_build/results?buildId=2767030&view=results

    Recorded

    @JackTn
    Copy link
    Member

    JackTn commented May 12, 2023

    approved @eatkimchee Do you need merge this pr now ?

    @eatkimchee
    Copy link
    Member Author

    Yes @JackTn please merge it so we can begin the SDK release process. Thanks!

    @TimLovellSmith
    Copy link
    Member

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @eatkimchee
    Copy link
    Member Author

    @TimLovellSmith @JackTn can you tell why the service api readiness test is failing now when it didn't fail for earlier commits? is this blocking?

    @eatkimchee
    Copy link
    Member Author

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @JackTn
    Copy link
    Member

    JackTn commented May 15, 2023

    @TimLovellSmith @JackTn can you tell why the service api readiness test is failing now when it didn't fail for earlier commits? is this blocking?

    @konrad-jamrozik help to tell us this api readiness test failing ? In my opinion this is due to the new api version not release yet. Let me know if i'm wrong. Thanks.

    @eatkimchee
    Copy link
    Member Author

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @TimLovellSmith TimLovellSmith added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label May 15, 2023
    @openapi-workflow-bot
    Copy link

    Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested

    @openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label May 15, 2023
    @eatkimchee eatkimchee removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label May 15, 2023
    @openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label May 15, 2023
    @eatkimchee
    Copy link
    Member Author

    Hi @TimLovellSmith , does this have all the changes you requested now?

    @TimLovellSmith TimLovellSmith added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label May 16, 2023
    @openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label May 16, 2023
    @TimLovellSmith
    Copy link
    Member

    I still have this nagging feeling that not marking it as x-ms-secret is going to come back to haunt me... aside from that I don't see any reason to hold this up.

    @konrad-jamrozik
    Copy link

    konrad-jamrozik commented May 16, 2023

    @TimLovellSmith @JackTn can you tell why the service api readiness test is failing now when it didn't fail for earlier commits? is this blocking?

    @konrad-jamrozik help to tell us this api readiness test failing ? In my opinion this is due to the new api version not release yet. Let me know if i'm wrong. Thanks.

    Sorry for the late reply!

    I see the failure is in ~[Staging] ServiceAPIReadinessTest. Overall, all failing checks that have ~[Staging] in the name can be safely ignored for the purpose of determining if the PR can be merged. If API Readiness Check would fail then we should deliberate, but I see it is passing.

    @eatkimchee
    Copy link
    Member Author

    Thanks @TimLovellSmith and @konrad-jamrozik. @JackTn whenever you get a chance to merge, it looks like we pass all the necessary checks now. Thanks!

    @JackTn JackTn added the Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates label May 17, 2023
    @JackTn
    Copy link
    Member

    JackTn commented May 17, 2023

    @msyyc can you help to merge this pr, Thanks

    @msyyc
    Copy link
    Member

    msyyc commented May 18, 2023

    @eatkimchee Do you want to merge it now?

    @eatkimchee
    Copy link
    Member Author

    @msyyc Yes please merge it now, thanks!

    @msyyc msyyc merged commit 5b07a79 into main May 18, 2023
    @msyyc msyyc deleted the published/Azure/azure-rest-api-specs-pr/eatkimchee-fist-Microsoft.IoTFirmwareDefense-2023-02-08-preview branch May 18, 2023 03:05
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review new-api-version new-rp-namespace ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager RPaaS
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    7 participants